<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="author" content="MkDocs Team">
    <link rel="canonical" href="https://www.mkdocs.org/user-guide/configuration/">
    <link rel="shortcut icon" href="../../img/favicon.ico">
    <title>Configuration - MkDocs</title>
    <link href="../../css/bootstrap.min.css" rel="stylesheet">
    <link href="../../css/font-awesome.min.css" rel="stylesheet">
    <link href="../../css/base.css" rel="stylesheet">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
    <link href="../../css/extra.css" rel="stylesheet">
    <link href="http://community.dev.readthedocs.io/devstoreaccount1/static/css/badge_only.css" rel="stylesheet">
    <link href="http://community.dev.readthedocs.io/devstoreaccount1/static/css/readthedocs-doc-embed.css" rel="stylesheet">

    <script src="../../js/jquery-1.10.2.min.js" defer></script>
    <script src="../../js/bootstrap.min.js" defer></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/yaml.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/django.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script> 
  </head>

  <body>
    <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
      <div class="container">
        <a class="navbar-brand" href="../..">MkDocs</a>
        <!-- Expander button -->
        <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
          <span class="navbar-toggler-icon"></span>
        </button>

        <!-- Expanded navigation -->
        <div id="navbar-collapse" class="navbar-collapse collapse">
          <!-- Main navigation -->
          <ul class="nav navbar-nav">
            <li class="navitem">
              <a href="../.." class="nav-link">Home</a>
            </li>
            <li class="dropdown active">
              <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
              <ul class="dropdown-menu">

                <li>
                  <a href="../writing-your-docs/" class="dropdown-item">Writing Your Docs</a>
                </li>

                <li>
                  <a href="../styling-your-docs/" class="dropdown-item">Styling Your Docs</a>
                </li>

                <li>
                  <a href="./" class="dropdown-item active">Configuration</a>
                </li>

                <li>
                  <a href="../deploying-your-docs/" class="dropdown-item">Deploying Your Docs</a>
                </li>

                <li>
                  <a href="../custom-themes/" class="dropdown-item">Custom Themes</a>
                </li>

                <li>
                  <a href="../plugins/" class="dropdown-item">Plugins</a>
                </li>
              </ul>
            </li>
            <li class="dropdown">
              <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
              <ul class="dropdown-menu">

                <li>
                  <a href="../../about/release-notes/" class="dropdown-item">Release Notes</a>
                </li>

                <li>
                  <a href="../../about/contributing/" class="dropdown-item">Contributing</a>
                </li>

                <li>
                  <a href="../../about/license/" class="dropdown-item">License</a>
                </li>
              </ul>
            </li>
          </ul>

          <ul class="nav navbar-nav ml-auto">
            <li class="nav-item">
              <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
                <i class="fa fa-search"></i> Search
              </a>
            </li>
            <li class="nav-item">
              <a rel="prev" href="../styling-your-docs/" class="nav-link">
                <i class="fa fa-arrow-left"></i> Previous
              </a>
            </li>
            <li class="nav-item">
              <a rel="next" href="../deploying-your-docs/" class="nav-link">
                Next <i class="fa fa-arrow-right"></i>
              </a>
            </li>
            <li class="nav-item">
              <a href="https://github.com/mkdocs/mkdocs/" class="nav-link"><i class="fa fa-github"></i> GitHub</a>
            </li>
          </ul>
        </div>
      </div>
    </div>

    <div class="container">
      <div class="row">
        <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
            <div class="navbar-header">
              <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
                <span class="fa fa-angle-down"></span>
              </button>
            </div>


            <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
              <ul class="nav flex-column">

                <li class="nav-item" data-level="1"><a href="#configuration" class="nav-link">Configuration</a>
                  <ul class="nav flex-column">
                    <li class="nav-item" data-level="2"><a href="#introduction" class="nav-link">Introduction</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                    <li class="nav-item" data-level="2"><a href="#project-information" class="nav-link">Project information</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                    <li class="nav-item" data-level="2"><a href="#documentation-layout" class="nav-link">Documentation layout</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                    <li class="nav-item" data-level="2"><a href="#build-directories" class="nav-link">Build directories</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                    <li class="nav-item" data-level="2"><a href="#preview-controls" class="nav-link">Preview controls</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                    <li class="nav-item" data-level="2"><a href="#formatting-options" class="nav-link">Formatting options</a>
                      <ul class="nav flex-column">
                      </ul>
                    </li>
                  </ul>
                </li>
              </ul>
            </div>
          </div></div>
          <div class="col-md-9" role="main">

            <h1 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link"></a></h1>
            <p>Guide to all available configuration settings.</p>
            <hr />
            <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link"></a></h2>
            <p>
              Project settings are always configured by using a YAML configuration file in the
              project directory named <code>mkdocs.yml</code>.</p>
            <p>
              As a minimum this configuration file must contain the <code>site_name</code> setting. All other settings are optional.
            </p>

            <h3 id="site_description">site_description<a class="headerlink" href="#site_description" title="Permanent link"></a></h3>
            <p>Set the site description. This will add a meta tag to the generated HTML header.</p>
            <p><strong>default</strong>: <code>null</code></p>

            <h3 id="site_author">site_author<a class="headerlink" href="#site_author" title="Permanent link"></a></h3>
            <p>
              Set the name of the author. This will add a meta tag to the generated HTML header.
            </p>

            <h2 id="preview-controls">Preview controls<a class="headerlink" href="#preview-controls" title="Permanent link"></a></h2>
            <h3 id="use_directory_urls">use_directory_urls<a class="headerlink" href="#use_directory_urls" title="Permanent link"></a></h3>
            <p>
              This setting controls the style used for linking to pages within the
              documentation.
            </p>
            <table>
              <thead>
                <tr>
                  <th>Source file</th>
                  <th>use_directory_urls: true</th>
                  <th>use_directory_urls: false</th>
                </tr>
              </thead>
              <tbody>
                <tr>
                  <td>index.md</td>
                  <td>/</td>
                  <td>/index.html</td>
                </tr>
                <tr>
                  <td>api-guide.md</td>
                  <td>/api-guide/</td>
                  <td>/api-guide.html</td>
                </tr>
                <tr>
                  <td>about/license.md</td>
                  <td>/about/license/</td>
                  <td>/about/license.html</td>
                </tr>
              </tbody>
            </table>

            <h5 id="lang"><strong>lang</strong><a class="headerlink" href="#lang" title="Permanent link"></a></h5>
            <p>
              A list of languages to use when building the search index as identified by their
              <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1</a> language codes.
            </p>
            <ul>
              <li><code>ar</code>: Arabic</li>
              <li><code>da</code>: Danish</li>
              <li><code>nl</code>: Dutch</li>
              <li><code>en</code>: English</li>
              <li><code>fi</code>: Finnish</li>
              <li><code>fr</code>: French</li>
              <li><code>de</code>: German</li>
              <li><code>hu</code>: Hungarian</li>
              <li><code>it</code>: Italian</li>
              <li><code>ja</code>: Japanese</li>
              <li><code>no</code>: Norwegian</li>
              <li><code>pt</code>: Portuguese</li>
              <li><code>ro</code>: Romanian</li>
              <li><code>ru</code>: Russian</li>
              <li><code>es</code>: Spanish</li>
              <li><code>sv</code>: Swedish</li>
              <li><code>th</code>: Thai</li>
              <li><code>tr</code>: Turkish</li>
              <li><code>vi</code>: Vietnamese</li>
            </ul>
          </div>
      </div>
    </div>

    <footer class="col-md-12">
      <hr>
      <p>Copyright &copy; 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.</p>
      <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
    </footer>
    <script>
      var base_url = "../..",
        shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
    </script>
    <script src="../../js/base.js" defer></script>
    <script src="../../readthedocs-data.js" defer></script>
    <script src="http://community.dev.readthedocs.io/devstoreaccount1/static/core/js/readthedocs-doc-embed.js" defer></script>
    <script src="http://community.dev.readthedocs.io/devstoreaccount1/static/javascript/readthedocs-analytics.js" defer></script>
    <script src="../../search/main.js" defer></script>

    <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
      <div class="modal-dialog modal-lg">
        <div class="modal-content">
          <div class="modal-header">
            <h4 class="modal-title" id="searchModalLabel">Search</h4>
            <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
          </div>
          <div class="modal-body">
            <p>
              From here you can search these documents. Enter
              your search terms below.
            </p>
            <form>
              <div class="form-group">
                <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
              </div>
            </form>
            <div id="mkdocs-search-results"></div>
          </div>
          <div class="modal-footer">
          </div>
        </div>
      </div>
    </div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
            <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
          </div>
          <div class="modal-body">
            <table class="table">
              <thead>
                <tr>
                  <th style="width: 20%;">Keys</th>
                  <th>Action</th>
                </tr>
              </thead>
              <tbody>
                <tr>
                  <td class="help shortcut"><kbd>?</kbd></td>
                  <td>Open this help</td>
                </tr>
                <tr>
                  <td class="next shortcut"><kbd>n</kbd></td>
                  <td>Next page</td>
                </tr>
                <tr>
                  <td class="prev shortcut"><kbd>p</kbd></td>
                  <td>Previous page</td>
                </tr>
                <tr>
                  <td class="search shortcut"><kbd>s</kbd></td>
                  <td>Search</td>
                </tr>
              </tbody>
            </table>
          </div>
          <div class="modal-footer">
          </div>
        </div>
      </div>
    </div>

  </body>
</html>
